Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document constants #340

Merged
merged 3 commits into from
Dec 2, 2024
Merged

Document constants #340

merged 3 commits into from
Dec 2, 2024

Conversation

chiphogg
Copy link
Contributor

@chiphogg chiphogg commented Dec 2, 2024

We update the installation guide, both to point users to the headers for
the constants, and to tell them how to include constants in the
single-file script. This made me realize that we had forgotten to make
constants available in @au//au, so I updated the BUILD file.

On the constant reference page, we now list the built-in constants. I
like the way the table looks!

On the monovalue types page, constants are a great example of monovalue
types, so I add them as an example.

We also add a how-to guide for making new constants.

Finally, now that we include built-in constants with the library, I
think Au's constant support is now best-in-class, so I am updating our
Alternatives page to list us as such.

Fixes #90.

We update the installation guide, both to point users to the headers for
the constants, and to tell them how to include constants in the
single-file script.  This made me realize that we had forgotten to make
constants available in `@au//au`, so I updated the BUILD file.

On the constant reference page, we now list the built-in constants.  I
like the way the table looks!

On the monovalue types page, constants are a great example of monovalue
types, so I add them as an example.

We also add a how-to guide for making new constants.

Finally, now that we include built-in constants with the library, I
think Au's constant support is now best-in-class, so I am updating our
Alternatives page to list us as such.

Fixes #90.
@chiphogg chiphogg added the release notes: 📝 documentation PR affecting library documentation label Dec 2, 2024
@chiphogg chiphogg requested a review from geoffviola December 2, 2024 19:43
Copy link
Contributor

@geoffviola geoffviola left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs look great. Thanks for specifying what already exists and how to add new ones.

@chiphogg chiphogg merged commit d5bbc6f into main Dec 2, 2024
13 checks passed
@chiphogg chiphogg deleted the chiphogg/doc#90 branch December 2, 2024 21:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
release notes: 📝 documentation PR affecting library documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Support constants
2 participants